/*-
 * Copyright (c) 2006, 2007 FTS Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the FTS Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      XMLDocumentParser.hpp
 *
 * $FTS$
 */
#ifndef _XML_DOCUMENT_PARSER_HPP__
#define _XML_DOCUMENT_PARSER_HPP__ 1

/**
  @file XMLDocumentParser.hpp
  @brief Plain text parser
*/

// Local Includes
#include <BaseParser.hpp>

namespace FTSS // FullTextSearchSystem
{

// FWD
class DocumentBuilder;

/**
  @class PlaintextParser PlaintextParser.hpp <PlaintextParser.hpp>
  @brief Base parser class
*/
class XMLDocumentParser:
  public BaseParser
{
public:
	/**
	  @brief Constructor
	*/
	XMLDocumentParser();

	/**
	  @brief A destructor
	*/
	~XMLDocumentParser() throw();

private:
	/** Inverted index builder                       */
	Indexer          * pIndexer;
	/** Storage of parsed documents                  */
	DocumentStorage  * pDocumentStorage;
	/** Lemmatizer cache                             */
	LemCache         * pLemCache;
	/** Helper to build document from list of tokens */
	DocumentBuilder  * pDocumentBuilder;
	/** Token position in stream                     */
	UINT_32            iTokenPos;
	/** First call of ParseChunk method              */
	UINT_32            iFirstCallForDocument;

	/**
	  @brief Store inverted index handler and document storage
	  @param pIIndexer - indexer
	  @param pIDocumentStorage - parsed document builder
	  @param pILemCache - cache for lemmatizer
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 SetHandlers(Indexer * pIIndexer, DocumentStorage * pIDocumentStorage, LemCache * pILemCache) throw();

	/**
	  @brief Parse part of document
	  @param sText - text to parse
	  @param iTextLength - size of text
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 ParseChunk(CCHAR_P sText, const UINT_32 & iTextLength) throw();

	/**
	  @brief Start new document
	  @param sDocName - name of document
	  @param iDocnameLength - document length
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 StartDocument(CCHAR_P sDocName, const UINT_32 & iDocnameLength) throw();

	/**
	  @brief End current document
	  @return 0 if success, -1 if any error occured
	*/
	INT_32 EndDocument() throw();

	/**
	  @brief Get current token position
	  @return current token position
	*/
	INT_32 GetTokenPos() throw();

	/**
	  @brief Copy constructor
	  @param oRHS - object to copy
	*/
	XMLDocumentParser(const XMLDocumentParser & oRHS);

	/**
	  @brief Copy operator
	  @param oRHS - object to copy
	  @return reference to self
	*/
	XMLDocumentParser & operator=(const XMLDocumentParser & oRHS);

	/**
	  @brief Handle token
	  @param sToken - token
	  @param iTokenLength - token length
	*/
	void Token(CCHAR_P sToken, const UINT_32 & iTokenLength);
};

} // namespace FTSS
#endif // _XML_DOCUMENT_PARSER_HPP__
// End.
